package com.mrzhou.swagger.config;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 *  Swagger2 默认配置文件
 */
@Getter
@Setter
@ToString
@ConfigurationProperties(prefix = "swagger")
public class Swagger2Properties {

     /** 分组名称 */
    private String groupName;

    /** controller接口所在包路径 */
    private List<String> basePackage = new ArrayList<>(Collections.singletonList("com.mrzhou"));

    /** 需要排除的路径 */
    private List<String> excludPath = new ArrayList<>();

    /** 文档标题 */
    private String title = "Cloud-MrZhou接口文档";

    /** 当前文档版本号 */
    private String version = "0.0.1";

    /** 当前文档的详细描述 */
    private String description = "这是接口文档地址";

    /** 是否需要对使用@ApiOperation注解进行监控, 默认为true,即允许监控 */
    private Boolean showApi = true;

    /** 服务条款的url */
    private String termsOfServiceUrl;

    /** 版本许可 */
    private String license;

    /** 版本许可url */
    private String licenseUrl;

}
